fix(docs): clarify mkdir does not throw with recursive: true#33019
Open
kovan wants to merge 1 commit intodenoland:mainfrom
Open
fix(docs): clarify mkdir does not throw with recursive: true#33019kovan wants to merge 1 commit intodenoland:mainfrom
kovan wants to merge 1 commit intodenoland:mainfrom
Conversation
The JSDoc for Deno.mkdir and Deno.mkdirSync said "Defaults to throwing error if the directory already exists" without mentioning that recursive: true suppresses this error. The MkdirOptions.recursive property already documented this behavior, but the function-level docs were misleading. Fixes denoland#21768
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The JSDoc for
Deno.mkdirandDeno.mkdirSyncsaid "Defaults to throwing error if the directory already exists" without mentioning thatrecursive: truesuppresses this error.The
MkdirOptions.recursiveproperty already documented this correctly, but the function-level docs were misleading. Changed to "Throws if the directory already exists, unlessrecursiveis set totrue."Fixes #21768